Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correcting IntentResult error in FDC3 2.0 and adding a very minor clarification to 2.1/next #1127

Merged
merged 2 commits into from
Jan 25, 2024

Conversation

kriswest
Copy link
Contributor

@kriswest kriswest commented Dec 6, 2023

resolves #1107

Updates FDC3 2.0's docs to match the correction applied in 2.1 and adds a minor clarification in the 2.1 and next specs to carry over into future versions.

An additional branch and PR will be needed to correct the type in a 2.0 NPM module release - although most will move to the 2.1 module (which has the correction and is backwards compatible with 2.0). We can do that release to NPM after this change is merged and approved.

Copy link

linux-foundation-easycla bot commented Dec 6, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link

netlify bot commented Dec 6, 2023

Deploy Preview for fdc3 ready!

Name Link
🔨 Latest commit cc68903
🔍 Latest deploy log https://app.netlify.com/sites/fdc3/deploys/6570b4aceb1a2f0008e168da
😎 Deploy Preview https://deploy-preview-1127--fdc3.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@openfin-johans openfin-johans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks all good to me!

@bingenito
Copy link
Member

bingenito commented Dec 7, 2023

Not sure if it changes the discussion, but this change in the .NET bindings is more significantly breaking on update. If I declare the interface member as Task<IIntentResult?> any desktop agents implementing this will fail to build on upgrade of the library (on a non semver major). With that said, we are publishing still as alpha versions and this can be a change when moving to publishing under Finos.Fdc3

@kriswest
Copy link
Contributor Author

kriswest commented Dec 7, 2023

@bingenito I understand your comment on this - it is a breaking change. It's one we already made in FDC3 2.1 (and without incrementing the major version number), as it wasn't what was intended in 2.0 (due to a mistake on my part).

When we agreed to change this in 2.1 there was a feeling that this feature wasn't heavily used (yet) and hence the sooner we fix it the better. Based on your comment, I think that still holds (although less so for those already using the .NET types) - but we very much need to avoid it happening again in the future, before those types are released under a finos/fdc3 namespace. Do you concur?

I suspect having you on the team to help us with reviews might help catch similar things (that matter more in .NET than JS/TS) will help!

@bingenito would implementing this in .NET be a case of changing the IntentResolution interface to:

public interface IIntentResolution
    {
        ...
        Task<IIntentResult?> GetResult();
    }

i.e. adding the ? as a hint that its possibly null.

That said I do hear there are newer approaches in later c# language versions (and I'm nowhere near competent in the old ones, let alone new ;-) )

@kriswest
Copy link
Contributor Author

/easycla

@kriswest kriswest merged commit f4a46c0 into master Jan 25, 2024
7 checks passed
@kriswest kriswest deleted the 1107-fix-intent-result-type-in-2.0 branch January 25, 2024 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Correction to the 2.0 IntentResult?
4 participants